Skip to content

Adopt pre commit hook for the codespell tool#847

Merged
davidorme merged 4 commits intodevelopfrom
846-adopt-pre-commit-hook-for-the-codespell-tool
May 9, 2025
Merged

Adopt pre commit hook for the codespell tool#847
davidorme merged 4 commits intodevelopfrom
846-adopt-pre-commit-hook-for-the-codespell-tool

Conversation

@davidorme
Copy link
Copy Markdown
Collaborator

@davidorme davidorme commented May 8, 2025 •
edited
Loading

Description

Does exactly what it says on the title.

Oh, and also fixes all the existing typos and stress up the configuration. The new .codespellignore.txt file is there to stop it moaning about matric.

Fixes #846

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@davidorme davidorme linked an issue May 8, 2025 that may be closed by this pull request
Adopt pre-commit hook for the codespell tool #846
Closed
@davidorme davidorme requested a review from vgro May 8, 2025 16:05
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.76%. Comparing base (f940858) to head (3fcaa9f).

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop     #847   +/-   ##
========================================
  Coverage    94.76%   94.76%           
========================================
  Files           75       75           
  Lines         5563     5563           
========================================
  Hits          5272     5272           
  Misses         291      291

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

vgro
vgro approved these changes May 9, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@vgro vgro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant, I'm always amazed what the human eye can ignore ;-)

@jacobcook1995
Copy link
Copy Markdown
Collaborator

jacobcook1995 commented May 9, 2025

Wow, I am pretty surprised by how well that worked! Only one word to ignore on the entire code base is amazingly good going

@davidorme
Copy link
Copy Markdown
Collaborator Author

davidorme commented May 9, 2025

Wow, I am pretty surprised by how well that worked! Only one word to ignore on the entire code base is amazingly good going

It's not a complete spellchecker - it looks for particular misspellings - so there may be some uncommon typos in technical words. But still pretty useful. Thanks for the tip @alexdewar

@davidorme davidorme enabled auto-merge May 9, 2025 09:43
@davidorme davidorme merged commit fde637c into develop May 9, 2025
16 checks passed
@davidorme davidorme deleted the 846-adopt-pre-commit-hook-for-the-codespell-tool branch May 9, 2025 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vgro vgro vgro approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adopt pre-commit hook for the codespell tool

4 participants

@davidorme @codecov-commenter @jacobcook1995 @vgro